home *** CD-ROM | disk | FTP | other *** search
/ BCI NET / BCI NET Dec 94.iso / archives / telecomm / bbs / axshsupp.lha / AXsh-Topic17.lha / topic.man < prev    next >
Text File  |  1992-10-28  |  3KB  |  98 lines
  1.  
  2.             Topic v. 1.7 Manual
  3.                         -------------------
  4.            Released 28-Oct-1992 by Markku 'Hack' Mellanen
  5.            ----------------------------------------------
  6. Topic program runs commands from menu by user's choise. You can make
  7. your own menus which includes commands you/user can execute.
  8. Topic was made to run under axsh but you can use also under ADOS....
  9.  
  10. You can give following parameters to TOPIC:
  11. first parameter is menu_file, so file name what will be as a main menu
  12. in topic. 
  13. Second parameter is a prompt displayed after menu.
  14. Exmpl. TOPIC MAIN_MENU.RC "CHOISE (Q TO QUIT):"
  15. Note if you have more than one word in prompt parameter use ""'s....
  16. In case you give no parameters, topic will use AXSH:ETC/TOPIC.RC and CHOISE 
  17. (Q TO QUIT): as a default file and prompt.
  18.  
  19. Structure of menu file: (Exmpl. TOPIC.RC)
  20.  
  21. +------------------------------+--------------------------------------------+
  22. |Commands:                     |                                            |
  23. |                              |                                            |
  24. |a)avail (Memory stat.)        |m)Msg menu                                  |
  25. |i)info  (Disk stat.)          |f)File menu                                 |
  26. |d)dir   (Directory)           |e)editor                                    |
  27. |w)who   (User on-line etc.)   |                                            |
  28. |c)Chat  (Chat with root)      |                                            |
  29. +------------------------------+--------------------------------------------+
  30. #
  31. a
  32. c:avail
  33. ---
  34. i
  35. info
  36. ---
  37. d
  38. c:dir
  39. ---opt a
  40. w
  41. type
  42. ---ram:env/sysghost
  43. c
  44. axsh:bin/cc
  45. ---
  46. m
  47. axsh:bin/topic
  48. ---axsh:etc/msgmenu.rc "Choise:"
  49. f
  50. axsh:bin/topic
  51. ---axsh:etc/filemenu.rc "Choise (Q to main menu):"
  52. e
  53. axsh:bin/editor
  54. -p?Filename:
  55. #
  56.  
  57. First part is text-part what will be displayed to user. # is a end mark of this
  58. part. After that come part where are defined all items, commands, flags and 
  59. parameters.
  60. First is a item, ex. A, then comes command what will be executed in case
  61. A is user's choise. Ex. AVAIL
  62. Then comes flags and parameters for command.
  63. First flag (r/-) is for RAW-mode, if flag is r, command will be executed in 
  64. raw mode. With every other letter command is executed in CON-mode!
  65. Second flag (p/-) stands for PATH-cheking, so if p-flag is true, topic
  66. will accept no paramters to command. (So it checks : and / marks in parameter)
  67. Third flag (?/-) must set if you want ask parameter from user 
  68. (Ex. ED --?Filename:). So if ? is true, topic will display text following ?-
  69. mark and ask parameter.
  70. Example:
  71. E
  72. axsh:bin/editor
  73. -p?Filename:
  74. will execute editor and ask filename from user and check that there are no
  75. : or / marks in paramter...
  76.  
  77. You can use sub-menus by running another topic by topic.
  78. Exmpl.
  79. S
  80. TOPIC 
  81. ---SUB_MENU.RC PROMPT
  82.  
  83. And sub-menu's structure is equal to main-menu's structure.
  84.  
  85. #-mark is endmark of menufile! You can put ANSI-control codes to
  86. your menufiles, program should not have any problems with them.
  87.  
  88. NOTE. If you don't give any parameters to command, remember to put
  89. --- in parameterline, otherwise progrem will get confused with
  90. item/command/flags...
  91. Program is case-sensitive with items and flags!
  92.  
  93. Bugs and improvement suggetions to:
  94. Markku Mellanen
  95. Valjaskatu 2 e 72 15830 Lahti
  96. Puh. 918-535 259
  97. Axnet: root@hack.lahti.fi
  98.